Add validator:status command to check if a validator signer is online and producing blocks #1906

nategraf · 2019-11-26T16:35:02Z

Description

Create a validator:status command to check the registration, election, and signing status of a validator.

Tested

Manually tested against local testnet

Backwards compatibility

Will not break anything. New command will work with networks that have parent seals in the block header.

Related Issues

Fixes: #1782

codecov · 2019-11-26T21:15:23Z

Codecov Report

Merging #1906 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           master    #1906    +/-   ##
========================================
  Coverage   74.42%   74.42%            
========================================
  Files         281      281            
  Lines        7824     7824            
  Branches      687      975   +288     
========================================
  Hits         5823     5823            
  Misses       1884     1884            
  Partials      117      117

Flag	Coverage Δ
#mobile	`74.42% <ø> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fdc4839...1f0c5c5. Read the comment docs.

…r/vx-online

nategraf · 2019-11-26T23:01:33Z

I've added a note to the running-a-validator doc to suggest using this command.

packages/cli/src/commands/validator/status.ts

mcortesi

Check lodash, i don't think it's included in package.json...

The rest are minor details!

packages/cli/src/commands/validator/status.ts

asaj · 2019-11-27T00:58:15Z

packages/cli/src/commands/validator/status.ts

+    // Use redundant checks to help the user diagnose issues.
+    await newCheckBuilder(this, signer)
+      .canSignValidatorTxs()
+      .signerMeetsValidatorBalanceRequirements()


I would expect us to fail this check whenever the validator has an authorized validator signer...

Where else is this used?

It's used here. https://github.com/celo-org/celo-monorepo/blob/master/packages/cli/src/commands/validator/register.ts#L32
I believe it should work. It calls signerToAccount on the provided signer then checks the balance requirement on the account that was retrieved. It's not strictly necessary though.

asaj · 2019-11-27T00:59:04Z

packages/cli/src/commands/validator/status.ts

+    const signers = await election.getCurrentValidatorSigners()
+    const signerIndex = signers.map((a) => a.toLowerCase()).indexOf(signer.toLowerCase())
+    if (signerIndex < 0) {
+      // Determine whether the signer will be elected at the next epoch to provide a helpful error.


This is great! Can we put this functionality in the election module instead?

We could add a command like election:validator-is-elected, but I personally don't see a ton of value in that because election:current and election:run exist and combined with grep you can tell whether a specific validator is in the set.

packages/cli/src/commands/validator/status.ts

…r/vx-online

…into victor/vx-online

packages/utils/src/istanbul.ts

…into victor/vx-online

…r/vx-online

asaj · 2019-12-05T00:59:10Z

packages/cli/src/commands/validator/status.ts

+  static flags = {
+    ...BaseCommand.flags,
+    signer: Flags.address({
+      description: 'address of the validator to check if elected and validating',


Are these descriptions swapped?

Yes. Fixed.

asaj · 2019-12-05T00:59:50Z

packages/cli/src/commands/validator/status.ts

+
+  static flags = {
+    ...BaseCommand.flags,
+    signer: Flags.address({


Can you make these flags exclusive? Example in validatorgroup:member

asaj · 2019-12-05T01:00:46Z

packages/cli/src/commands/validator/status.ts

+      const account = res.flags.validator
+      checker.isValidator(account).meetsValidatorBalanceRequirements(account)
+    } else if (res.flags.signer) {
+      checker.signerMeetsValidatorBalanceRequirements().signerAccountIsValidator()


Rather than add additional checks, why don't we just pull the account from the signer and run the same checks on the account?

At this point in the code it is unclear whether the accounts given are valid and I wanted to avoid an opaque call reversion. I realized that as coded it still has that issue, so I've added an isAccount check.

asaj · 2019-12-05T01:03:10Z

packages/cli/src/commands/validator/status.ts

+      const frontrunners = await election.electValidatorSigners()
+      if (frontrunners.some((a) => eqAddress(a, signer))) {
+        this.error(
+          `Signer ${signer} is not elected for this epoch, but is currently winning in the upcoming election. Wait for the next epoch.`


but would be elected to the validator set for the next epoch if an election were to be held now. Please wait until the next epoch.

asaj · 2019-12-05T01:03:29Z

packages/cli/src/commands/validator/status.ts

+        )
+      } else {
+        this.error(
+          `Signer ${signer} is not elected for this epoch, and is not currently winning the upcoming election.`


and would not be elected to the validator set for the next epoch if an election were to be held now.

…into victor/vx-online

…r/vx-online

…g/celo-monorepo into aaronmgdr/protect-proxied-routes * 'aaronmgdr/protect-proxied-routes' of github.com:celo-org/celo-monorepo: Add validator:status command to check if a validator signer is online and producing blocks (#1906)

* master: (208 commits) Fix potential hard timeouts (#2072) Add checkzero,blockscout,mulit-address support to faucet. Fix broken envType checks (#2068) README added mission (#1972) Add dev-utils README (#2081) Add validator:status command to check if a validator signer is online and producing blocks (#1906) Experience Brand Kit 1.0 (#1948) Adjust reference to the rewards app (#2065) [Wallet] Compatibility with exchange rate in string format (#2060) Fix Typo in CI config (#2056) Fix additional attestations instructions (#2057) Allow a specified address to disable/enable rewards distribution (#1828) Aaronmgdr/leaderboard patch (#2055) Move attestation service instructions to main page (#2051) Point To Updated Join Celo Video (#2052) Fix minor issue withe the ordering of instructions changes to docs related to discovery (#2025) [Docs] Fix typos in Running a Validator docs (#2045) Add node flag to celocli to set the target node for a single command (#2020) Fix broken links and spruce up CLI docs for accounts command (#2027) Prevent clipping of arrow component (#2036) ... # Conflicts: # packages/web/src/layout/BookLayout.tsx # packages/web/src/lib.dom.d.ts

Victor Graf added 5 commits November 26, 2019 09:58

create validator:online command to check if a validator is alive

fca5fde

add a couple more checks

33674b7

add a check

9ac6868

rename online to status

ebfa798

remove k

0ecea6b

nategraf requested review from asaj and mcortesi as code owners November 26, 2019 16:35

Victor Graf added 3 commits November 26, 2019 10:37

remove extra ts-ignore

94c8248

fix web3.eth.getBlock

af8e695

update docs

1afa4df

Victor Graf added 5 commits November 26, 2019 16:17

provide more helpful message about election status

b1bd6f8

allow specifying validator and lookback

3a67701

Merge branch 'master' of github.com:celo-org/celo-monorepo into victo…

ffe6a22

…r/vx-online

add note to running-a-validator doc

1a61d52

Merge branch 'master' of github.com:celo-org/celo-monorepo into victo…

45e819e

…r/vx-online

nategraf assigned asaj and mcortesi Nov 26, 2019

add address import

06b06ad

mcortesi reviewed Nov 27, 2019

View reviewed changes

packages/cli/src/commands/validator/status.ts Outdated Show resolved Hide resolved

mcortesi reviewed Nov 27, 2019

View reviewed changes

packages/cli/src/commands/validator/status.ts Outdated Show resolved Hide resolved

mcortesi reviewed Nov 27, 2019

View reviewed changes

packages/cli/src/commands/validator/status.ts Outdated Show resolved Hide resolved

mcortesi reviewed Nov 27, 2019

View reviewed changes

packages/cli/src/commands/validator/status.ts Outdated Show resolved Hide resolved

mcortesi approved these changes Nov 27, 2019

View reviewed changes

mcortesi assigned nategraf and unassigned mcortesi Nov 27, 2019

Merge branch 'master' into victor/vx-online

806e11b

asaj reviewed Nov 27, 2019

View reviewed changes

asaj removed their assignment Nov 27, 2019

Victor "Nate" Graf added 4 commits December 3, 2019 17:02

Merge branch 'master' into victor/vx-online

57c9640

Merge branch 'master' of github.com:celo-org/celo-monorepo into victo…

d862886

…r/vx-online

Merge branch 'victor/vx-online' of github.com:celo-org/celo-monorepo …

ddad057

…into victor/vx-online

Merge branch 'master' into victor/vx-online

93aa9c7

jmrossy reviewed Dec 4, 2019

View reviewed changes

packages/utils/src/istanbul.ts Outdated Show resolved Hide resolved

Victor "Nate" Graf added 10 commits December 4, 2019 06:38

Merge branch 'master' into victor/vx-online

bb7cdf5

export IstanbulUtils

41ba66b

Merge branch 'victor/vx-online' of github.com:celo-org/celo-monorepo …

73985d9

…into victor/vx-online

Merge branch 'master' into victor/vx-online

ec42fa3

Merge branch 'master' into victor/vx-online

4e962e7

Merge branch 'master' into victor/vx-online

3958aad

Merge branch 'master' into victor/vx-online

e3e2c8c

Merge branch 'master' into victor/vx-online

23d61fe

Merge branch 'master' of github.com:celo-org/celo-monorepo into victo…

825d3e1

…r/vx-online

Merge branch 'master' into victor/vx-online

91a7f5d

asaj approved these changes Dec 5, 2019

View reviewed changes

asaj assigned nategraf and unassigned asaj Dec 5, 2019

jmrossy approved these changes Dec 5, 2019

View reviewed changes

Victor "Nate" Graf added 7 commits December 5, 2019 08:54

Merge branch 'master' into victor/vx-online

0de04ca

Merge branch 'victor/vx-online' of github.com:celo-org/celo-monorepo …

4247518

…into victor/vx-online

address review comments

eec6e8f

fix type error

d64020b

fix typo

a9220dc

update docs

80eb702

Merge branch 'master' of github.com:celo-org/celo-monorepo into victo…

1f0c5c5

…r/vx-online

nategraf merged commit 0ad5e9a into master Dec 5, 2019

cmcewen deleted the victor/vx-online branch December 30, 2019 18:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add validator:status command to check if a validator signer is online and producing blocks #1906

Add validator:status command to check if a validator signer is online and producing blocks #1906

nategraf commented Nov 26, 2019 •

edited

Loading

codecov bot commented Nov 26, 2019 •

edited

Loading

nategraf commented Nov 26, 2019

mcortesi left a comment

asaj Nov 27, 2019

nategraf Dec 3, 2019

asaj Nov 27, 2019

nategraf Dec 3, 2019

asaj Dec 5, 2019

nategraf Dec 5, 2019

asaj Dec 5, 2019

nategraf Dec 5, 2019

asaj Dec 5, 2019

nategraf Dec 5, 2019

asaj Dec 5, 2019

asaj Dec 5, 2019

nategraf Dec 5, 2019

Add validator:status command to check if a validator signer is online and producing blocks #1906

Add validator:status command to check if a validator signer is online and producing blocks #1906

Conversation

nategraf commented Nov 26, 2019 • edited Loading

Description

Tested

Backwards compatibility

Related Issues

codecov bot commented Nov 26, 2019 • edited Loading

Codecov Report

nategraf commented Nov 26, 2019

mcortesi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nategraf commented Nov 26, 2019 •

edited

Loading

codecov bot commented Nov 26, 2019 •

edited

Loading